Get-IMMemory

SYNOPSIS

Retrieves Immich memories and memory collections.

SYNTAX

list (Default)

Get-IMMemory [-Session <ImmichSession>] [-Order <String>] [-For <DateTime>] [-NumberOfMemories <Int32>]
 [-IsSaved] [-IsTrashed] [-Type <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

id

Get-IMMemory [-Session <ImmichSession>] -id <String[]> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

statistics

Get-IMMemory [-Session <ImmichSession>] [-Order <String>] [-For <DateTime>] [-NumberOfMemories <Int32>]
 [-IsSaved] [-IsTrashed] [-Type <String>] [-Statistics] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

The Get-IMMemory function retrieves memories from Immich, which are curated collections of assets organized around specific dates, events, or themes. Memories help users rediscover and enjoy their photo collections through automated or manual curation.

When called without parameters, the function returns all available memories. When provided with specific memory IDs, it returns detailed information about those particular memories, including associated assets and metadata.

EXAMPLES

EXAMPLE 1

Get-IMMemory

Retrieves all available memories from the Immich instance.

EXAMPLE 2

Get-IMMemory -Id 'bf973405-3f2a-48d2-a687-2ed4167164be'

Retrieves detailed information about the memory with the specified ID.

EXAMPLE 3

$memoryIds = @('bf973405-3f2a-48d2-a687-2ed4167164be', '9c4e0006-3a2b-4967-94b6-7e8bb8490a12')
$memoryIds | Get-IMMemory

Retrieves multiple specific memories using pipeline input.

EXAMPLE 4

Get-IMMemory | Where-Object { $_.assets.Count -gt 10 }

Gets all memories and filters to show only those containing more than 10 assets.

EXAMPLE 5

Get-IMMemory -Order desc -NumberOfMemories 5

Retrieves the 5 most recent memories in descending order.

EXAMPLE 6

Get-IMMemory -Type on_this_day -For (Get-Date '2023-12-25')

Retrieves "on this day" memories for Christmas 2023, showing memories from December 25th in previous years.

EXAMPLE 7

Get-IMMemory -IsSaved -Order asc

Retrieves all saved memories in ascending (oldest first) order.

EXAMPLE 8

Get-IMMemory -Statistics

Retrieves memory statistics and summary information.

EXAMPLE 9

Get-IMMemory -Statistics -Order desc -NumberOfMemories 10

Retrieves memory statistics with descending order, limited to 10 results.

PARAMETERS

-Session

Optionally define a immich session object to use. This is useful when you are connected to more than one immich instance.

-Session $Session

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-id

Specifies the unique identifier(s) of specific memories to retrieve. Must be valid GUID format. Accepts pipeline input by value and by property name for batch retrieval operations. When omitted, all available memories are returned.

Type: String[]
Parameter Sets: id
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Order

Specifies the sort order for returned memories when retrieving all memories. Valid values are 'asc' (ascending), 'desc' (descending), or 'random' (random order). Only applies when retrieving all memories (list parameter set).

Type: String
Parameter Sets: list, statistics
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-For

Specifies a specific date to retrieve memories for. Memories associated with or created around this date will be returned. Only applies when retrieving all memories.

Type: DateTime
Parameter Sets: list, statistics
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NumberOfMemories

Specifies the maximum number of memories to return when retrieving all memories. This parameter limits the result set size for performance and pagination purposes. Alias: Size. Only applies when retrieving all memories (list parameter set).

Type: Int32
Parameter Sets: list, statistics
Aliases: Size

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-IsSaved

When specified, filters to return only memories that have been marked as saved. Only applies when retrieving all memories (list parameter set).

Type: SwitchParameter
Parameter Sets: list, statistics
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsTrashed

When specified, filters to return only memories that have been moved to trash. Only applies when retrieving all memories (list parameter set).

Type: SwitchParameter
Parameter Sets: list, statistics
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Type

Specifies the type of memories to retrieve. Currently supports 'on_this_day' type which returns memories from the same date in previous years. Only applies when retrieving all memories (list parameter set).

Type: String
Parameter Sets: list, statistics
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Statistics

When specified, retrieves memory statistics instead of memory objects. Returns statistical information about memories such as counts, distributions, and summaries. This creates a separate parameter set that supports Order and NumberOfMemories parameters.

Type: SwitchParameter
Parameter Sets: statistics
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Memories represent curated collections that help users rediscover their photos. The 'list' parameter set returns all memories, while the 'id' parameter set returns specific memories.

RELATED LINKS

EDIT THIS DOC

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github